SCS Application Programming Interface

SCS Events offer the ability to call remote (your) APIAn application programming interface is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. s via the Execute Web Hook action in any Action Sequence you define.  This can be anytime during an event, such as when a button is pressed (CTD in water, net at depth, buoy deployed, etc) or a more general concept (when an event is over and ready to be processed).  

 

This will always be via an HTTP POSTIn computing, POST is a request method supported by HTTP used by the World Wide Web. By design, the POST request method requests that a web server accept the data enclosed in the body of the request message, most likely for storing it. It is often used when uploading a file or when submitting a completed web form..

 

The POST will have form encoded content (name/value pairs) consisting of:

  SCS Version: The version of SCS which is making the call

  TemplateId: The unique ID of the Event Template which was used to define the event making this call

  EventId: The unique ID of the Event instance making this call (can be used later to retrieve the data for this event via the GetEventData API endpoint)

  EventName: The name of the event making this call

  EventStart: The time stamp of when this event started (ISO 8601 compliant format such as 2008-06-15T21:15:07.0000000)

  ActionExecuted: The time stamp of when this event action was triggered (ISO 8601 compliant format such as 2008-06-15T21:15:07.0000000)

 

When a user configures the Event template they decide if any actual event or sensor data is sent over in this call.  If they decide to include this then each item will also be included in the form data above POST'd to your endpoint.

 

SCSv5                                                                                                        Page 1 of 1